Skip to content

Update hub

Request

Modifies basic settings of an existing Hub. Only modified attributes may be passed in payload. All other attributes will remain unchanged.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
Bodyapplication/json
namestring
product_urlstring or null

URL of the product or service for which current Hub is set-up for. Alternatively called "Monitored site URL" in Hub Main Settings in StatusHub Control Panel.

Used as a link target for Hub name or Logo in Hub Page top-bar.

Example:"https://www.example-company.com/service"
subdomainstring[a-z0-9][a-z0-9_-]*[a-z0-9]

Hub subdomain.
Hub subdomain serves two purposes:

  • In various places it is being used as Hub unique identifier in place of less descriptive numerical ID,
  • Forms Hub URL which without custom domain in place has a form of https://{{subdomain}}.statushub.io.
Example:"company-status"
curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "product_url": "https://www.example-company.com/service",
    "subdomain": "company-status"
  }'

Responses

OK

Bodyapplication/json
idinteger, >= 1
Example:3
namestring
subdomainstring[a-z0-9][a-z0-9_-]*[a-z0-9]

Hub subdomain.
Hub subdomain serves two purposes:

  • In various places it is being used as Hub unique identifier in place of less descriptive numerical ID,
  • Forms Hub URL which without custom domain in place has a form of https://{{subdomain}}.statushub.io.
Example:"company-status"
typestring

Hub type:

  • Primary Hub Independent Hub without any overlap with other Hubs data. Associated with billing subscription, Can have Connected Hubs if its subscription allows it.

  • Connected Hub - Hub that shares following aspects with its Primary Hub:

    • Subset of Groups,
    • Subset of Services,
    • Events affecting the shared Services,
    • Subscription.

    All other data like Subscriptions and settings is independent.

Enum:"primary""connected"
Example:"primary"
custom_domainstring or null

Alternative domain name under which the Hub can be accessed.
Currently this field can be set only through a support ticket because of the additional steps required like setting up the TLS certificate.

Example:"status.example-company.com"
parent_idinteger or null, [ 1 .. 9999 ]

Present only for Connected Hubs. For Primary Hubs this field is absent or has null.
Contains the numerical ID of Primary Hub for current Connected Hub.

product_urlstring or null

URL of the product or service for which current Hub is set-up for. Alternatively called "Monitored site URL" in Hub Main Settings in StatusHub Control Panel.

Used as a link target for Hub name or Logo in Hub Page top-bar.

Example:"https://www.example-company.com/service"
created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"
updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"
Response
{
  "id": 3,
  "name": "string",
  "subdomain": "company-status",
  "type": "primary",
  "custom_domain": "status.example-company.com",
  "parent_id": 1,
  "product_url": "https://www.example-company.com/service",
  "created_at": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z"
}